API Reference

Forms

get
https://forms.cortextech.io/v1/external/forms

Returns all forms, filtered by query parameters.

Authentication

The request must supply valid API key headers:

  • X-APP-ID
  • X-API-KEY

As of July 2023, the following header is expected by new clients:

  • X-CLIENT-ID

Response

FieldTypeNullableDescription
idstringNForm ID.
titlestringNForm title.
descriptionstringYForm description (if present).
publishFromstringNISO 8601 datetime of when the form was published.
publishTostringYISO 8601 datetime of when the form is publish till. If null, the form never expires.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Zero indexed page offset. Default: 0 [optional]

string

Number of results to return per page. Default: 50 [optional]

string

Field to sort by. Prefix with - to sort in descending order. Default: publishFrom [optional]

string

Search by title, description or form ID. [optional]

string

Filter results to only include forms that were published after the provided ISO 8601 datetime (YYYY-MM-DD'T'HH:mm:ss'Z'). [optional]

string

Filter results to only include forms that were published before the provided ISO 8601 datetime (YYYY-MM-DD'T'HH:mm:ss'Z'). [optional]

Headers
string
required
string
required
Response

Updated about 15 hours ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 15 hours ago

Did this page help you?